<!--

     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
     regarding copyright ownership.  The ASF licenses this file
     to you under the Apache License, Version 2.0 (the
     "License"); you may not use this file except in compliance
     with the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing,
     software distributed under the License is distributed on an
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
     under the License.

-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- **************************************************************** -->
<!-- *  PLEASE KEEP COMPLICATED EXPRESSIONS OUT OF THESE TEMPLATES, * -->
<!-- *  i.e. only iterate & print data where possible. Thanks, Jez. * -->
<!-- **************************************************************** -->

<html>
<head>
    <!-- Generated by groovydoc (2.4.7) on Thu Dec 01 22:36:12 PST 2016 -->
    <title>ServiceCallAsync (Moqui Framework 2.0.0)</title>
    <meta name="date" content="2016-12-01">
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <link href="../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
    <link href="../../../groovy.ico" type="image/x-icon" rel="icon">
    <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

<body class="center">
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
    parent.document.title="ServiceCallAsync (Moqui Framework 2.0.0)";
}
//-->
</script>
<noscript>
    <div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
    <!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
    <!--   -->
</a>
    <ul class="navList" title="Navigation">
        <li><a href="../../../overview-summary.html">Overview</a></li>
        <li><a href="package-summary.html">Package</a></li>
        <li class="navBarCell1Rev">Class</li>
        <li><a href="../../../deprecated-list.html">Deprecated</a></li>
        <li><a href="../../../index-all.html">Index</a></li>
        <li><a href="../../../help-doc.html">Help</a></li>
    </ul>
</div>

<div class="subNav">
    <div>
        <ul class="navList">
            <li><a href="../../../index.html?org/moqui/service/ServiceCallAsync" target="_top">Frames</a></li>
            <li><a href="ServiceCallAsync.html" target="_top">No Frames</a></li>
        </ul>
    </div>
    <div>
        <ul class="subNavList">
            <li>Summary:&nbsp;</li>
            Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
        <ul class="subNavList">
            <li>&nbsp;|&nbsp;Detail:&nbsp;</li>
            Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
    </div>
    <a name="skip-navbar_top">
        <!--   -->
    </a></div>
<!-- ========= END OF TOP NAVBAR ========= -->

<!-- ======== START OF CLASS DATA ======== -->
<div class="header">

    <div class="subTitle">Package: <strong>org.moqui.service</strong></div>

    <h2 title="[Java] Interface ServiceCallAsync" class="title">[Java] Interface ServiceCallAsync</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><ul class="inheritance"></ul></li><li>org.moqui.service.ServiceCall
</ul>
<div class="description">
    <ul class="blockList">
        <li class="blockList">

            <dl>
                <dt>All Superinterfaces:</dt>
                <dd><a href='../../../org/moqui/service/ServiceCall.html'>ServiceCall</a></dd>
            </dl>

          </li>
    </ul>
</div>

<div class="summary">
    <ul class="blockList">
        <li class="blockList">
        <!-- =========== NESTED CLASS SUMMARY =========== -->
        

        <!-- =========== ENUM CONSTANT SUMMARY =========== -->
        
        <!-- =========== FIELD SUMMARY =========== -->
        

        <!-- =========== PROPERTY SUMMARY =========== -->
        

        <!-- =========== ELEMENT SUMMARY =========== -->
        

        

        
        <!-- ========== METHOD SUMMARY =========== -->
        <ul class="blockList">
            
            <li class="blockList"><a name="method_summary"><!--   --></a>
                    <h3>Methods Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Methods Summary table">
                        <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Type</th>
                            <th class="colLast" scope="col">Name and description</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>void</strong></code></td>
                            <td class="colLast"><code><strong><a href="#call()">call</a></strong>()</code><br>Call the service asynchronously, ignoring the result.
 </td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>java.util.concurrent.Future&lt;java.util.Map&lt;java.lang.String, java.lang.Object&gt;&gt;</strong></code></td>
                            <td class="colLast"><code><strong><a href="#callFuture()">callFuture</a></strong>()</code><br>Call the service asynchronously, and get a java.util.concurrent.Future object back so you can wait for the service to
 complete and get the result.</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../org/moqui/service/ServiceCallAsync.html'>ServiceCallAsync</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#distribute(boolean)">distribute</a></strong>(boolean dist)</code><br>If true the service call will be run distributed and may run on a different member of the cluster. </td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>java.util.concurrent.Callable&lt;java.util.Map&lt;java.lang.String, java.lang.Object&gt;&gt;</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getCallable()">getCallable</a></strong>()</code><br>Get a Callable object to do this service call through an ExecutorService of your choice.</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>java.lang.Runnable</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getRunnable()">getRunnable</a></strong>()</code><br>Get a Runnable object to do this service call through an ExecutorService or other runner of your choice.</td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../org/moqui/service/ServiceCallAsync.html'>ServiceCallAsync</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#name(java.lang.String)">name</a></strong>(java.lang.String serviceName)</code><br>Name of the service to run. </td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../org/moqui/service/ServiceCallAsync.html'>ServiceCallAsync</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#name(java.lang.String, java.lang.String)">name</a></strong>(java.lang.String verb, java.lang.String noun)</code><br></td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../org/moqui/service/ServiceCallAsync.html'>ServiceCallAsync</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#name(java.lang.String, java.lang.String, java.lang.String)">name</a></strong>(java.lang.String path, java.lang.String verb, java.lang.String noun)</code><br></td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../org/moqui/service/ServiceCallAsync.html'>ServiceCallAsync</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#parameter(java.lang.String, java.lang.Object)">parameter</a></strong>(java.lang.String name, java.lang.Object value)</code><br>Single name, value pairs to put in the context (in parameters) passed to the service.</td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../org/moqui/service/ServiceCallAsync.html'>ServiceCallAsync</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#parameters(Map<String, ?>)">parameters</a></strong>(java.util.Map&lt;java.lang.String, ?&gt; context)</code><br>Map of name, value pairs that make up the context (in parameters) passed to the service.</td>
                        </tr>
                        
                    </table>
                   </ul>
              </li>
            
            <li class="blockList"><a name="method_summary"><!--   --></a>
                    <h3>Inherited Methods Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Inherited Methods Summary table">
                        <caption><span>Inherited Methods</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Methods inherited from class</th>
                            <th class="colLast" scope="col">Name</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>interface <a href='../../../org/moqui/service/ServiceCall.html'>ServiceCall</a></strong></code></td>
                            <td class="colLast"><code><a href='../../../org/moqui/service/ServiceCall.html#getCurrentParameters()'>getCurrentParameters</a>, <a href='../../../org/moqui/service/ServiceCall.html#getServiceName()'>getServiceName</a></code></td>
                        </tr>
                    </table>
                   </ul>
              </li>
                
        </ul>
        
    </li>
    </ul>
</div>

<div class="details">
    <ul class="blockList">
        <li class="blockList">
           

            

            

            

            


            
            <!-- =========== METHOD DETAIL =========== -->
            <ul class="blockList">
                <li class="blockList"><a name="method_detail">
                    <!--   -->
                </a>
                    <h3>Method Detail</h3>
                    
                        <a name="call()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;void <strong>call</strong>()</h4>
                                <p> Call the service asynchronously, ignoring the result.
 This effectively calls the service through a java.lang.Runnable implementation.
     </p>
                            </li>
                        </ul>
                    
                        <a name="callFuture()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;java.util.concurrent.Future&lt;java.util.Map&lt;java.lang.String, java.lang.Object&gt;&gt; <strong>callFuture</strong>()</h4>
                                <p> Call the service asynchronously, and get a java.util.concurrent.Future object back so you can wait for the service to
 complete and get the result.

 This is useful for running a number of service simultaneously and then getting
 all of the results back which will reduce the total running time from the sum of the time to run each service
 to just the time the longest service takes to run.

 This effectively calls the service through a java.util.concurrent.Callable implementation.
     </p>
                            </li>
                        </ul>
                    
                        <a name="distribute(boolean)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;<a href='../../../org/moqui/service/ServiceCallAsync.html'>ServiceCallAsync</a> <strong>distribute</strong>(boolean dist)</h4>
                                <p> If true the service call will be run distributed and may run on a different member of the cluster. Parameter
 entries MUST be java.io.Serializable (or java.io.Externalizable).

 If false it will be run local only (default).
     <DL><DT><B>Returns:</B></DT><DD>Reference to this for convenience.</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="getCallable()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;java.util.concurrent.Callable&lt;java.util.Map&lt;java.lang.String, java.lang.Object&gt;&gt; <strong>getCallable</strong>()</h4>
                                <p> Get a Callable object to do this service call through an ExecutorService of your choice. </p>
                            </li>
                        </ul>
                    
                        <a name="getRunnable()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;java.lang.Runnable <strong>getRunnable</strong>()</h4>
                                <p> Get a Runnable object to do this service call through an ExecutorService or other runner of your choice. </p>
                            </li>
                        </ul>
                    
                        <a name="name(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;<a href='../../../org/moqui/service/ServiceCallAsync.html'>ServiceCallAsync</a> <strong>name</strong>(java.lang.String serviceName)</h4>
                                <p> Name of the service to run. The combined service name, like: "${path}.${verb}${noun}". To explicitly separate
 the verb and noun put a hash (#) between them, like: "${path}.${verb}#${noun}" (this is useful for calling the
 implicit entity CrUD services where verb is create, update, or delete and noun is the name of the entity).
     </p>
                            </li>
                        </ul>
                    
                        <a name="name(java.lang.String, java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;<a href='../../../org/moqui/service/ServiceCallAsync.html'>ServiceCallAsync</a> <strong>name</strong>(java.lang.String verb, java.lang.String noun)</h4>
                                <p></p>
                            </li>
                        </ul>
                    
                        <a name="name(java.lang.String, java.lang.String, java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;<a href='../../../org/moqui/service/ServiceCallAsync.html'>ServiceCallAsync</a> <strong>name</strong>(java.lang.String path, java.lang.String verb, java.lang.String noun)</h4>
                                <p></p>
                            </li>
                        </ul>
                    
                        <a name="parameter(java.lang.String, java.lang.Object)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;<a href='../../../org/moqui/service/ServiceCallAsync.html'>ServiceCallAsync</a> <strong>parameter</strong>(java.lang.String name, java.lang.Object value)</h4>
                                <p> Single name, value pairs to put in the context (in parameters) passed to the service. </p>
                            </li>
                        </ul>
                    
                        <a name="parameters(Map<String, ?>)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;<a href='../../../org/moqui/service/ServiceCallAsync.html'>ServiceCallAsync</a> <strong>parameters</strong>(java.util.Map&lt;java.lang.String, ?&gt; context)</h4>
                                <p> Map of name, value pairs that make up the context (in parameters) passed to the service. </p>
                            </li>
                        </ul>
                    
                </li>
            </ul>
            
        </li>
    </ul>
</div>

<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
    <!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
    <!--   -->
</a>
    <ul class="navList" title="Navigation">
        <li><a href="../../../overview-summary.html">Overview</a></li>
        <li><a href="package-summary.html">Package</a></li>
        <li class="navBarCell1Rev">Class</li>
        <li><a href="../../../deprecated-list.html">Deprecated</a></li>
        <li><a href="../../../index-all.html">Index</a></li>
        <li><a href="../../../help-doc.html">Help</a></li>
    </ul>
</div>

<div class="subNav">
    <div>
        <ul class="navList">
            <li><a href="../../../index.html?org/moqui/service/ServiceCallAsync" target="_top">Frames</a></li>
            <li><a href="ServiceCallAsync.html" target="_top">No Frames</a></li>
        </ul>
    </div>
    <div>
        <ul class="subNavList">
            <li>Summary:&nbsp;</li>
            Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
        <ul class="subNavList">
            <li>&nbsp;|&nbsp;Detail:&nbsp;</li>
            Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
    </div>
    <p>Groovy Documentation</p>
    <a name="skip-navbar_bottom">
        <!--   -->
    </a>
    </div>
</div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
